document that utf8proc_map simply wraps utf8proc_decompose and utf8proc_reencode...

diff --git a/utf8proc.h b/utf8proc.h
index 76199496fdc0f5636d3b34db002f407b0a178e70..b43904f49a3d1f8e359219b79b9dce5c540b1096 100644 (file)
--- a/utf8proc.h
+++ b/utf8proc.h
@@ -750,6 +750,10 @@ UTF8PROC_DLLEXPORT const char *utf8proc_category_string(utf8proc_int32_t codepoi
  *
  * @note The memory of the new UTF-8 string will have been allocated
  * with `malloc`, and should therefore be deallocated with `free`.
+ *
+ * @note `utf8proc_map` simply calls `utf8proc_decompose` followed by `utf8proc_reencode`,
+ * and applications requiring greater control over memory allocation should instead call
+ * those two functions directly.
  */
 UTF8PROC_DLLEXPORT utf8proc_ssize_t utf8proc_map(
   const utf8proc_uint8_t *str, utf8proc_ssize_t strlen, utf8proc_uint8_t **dstptr, utf8proc_option_t options